Overview | Package | Class | Tree | Deprecated | Index | Help			Java Platform 1.1.7
PREV CLASS | NEXT CLASS	FRAMES | NO FRAMES
SUMMARY: INNER | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

Class com.sun.java.swing.JCheckBoxMenuItem

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--com.sun.java.swing.JComponent
                    |
                    +--com.sun.java.swing.AbstractButton
                          |
                          +--com.sun.java.swing.JMenuItem
                                |
                                +--com.sun.java.swing.JCheckBoxMenuItem

public class JCheckBoxMenuItem

extends JMenuItem

implements SwingConstants, Accessible

A menu item that can be selected or deselected. If selected, the menu item typically appears with a checkmark next to it. If unselected or deselected, the menu item appears without a checkmark. Like a regular menu item, a checkbox menu item can have either text or a graphic icon associated with it, or both.

Either isSelected/setSelected or getState/setState can be used to determine/specify the menu item's selection state. (The Swing-standard methods are isSelected and setSelected. These methods work for all menus and buttons. The getState and setState methods exist for compatibility with other component sets.)

For the keyboard keys used by this component in the standard Look and Feel (L&F) renditions, see the JCheckBoxMenuItem key assignments.

Warning: serialized objects of this class will not be compatible with future swing releases. The current serialization support is appropriate for short term storage or RMI between Swing1.0 applications. It will not be possible to load serialized Swing1.0 objects with future releases of Swing. The JDK1.2 release of Swing will be the compatibility baseline for the serialized form of Swing objects.

See Also:

Serialized Form

Inner Class Summary

JCheckBoxMenuItem.AccessibleJCheckBoxMenuItem The class used to obtain the accessible role for this object.

Inner classes inherited from class com.sun.java.swing.JMenuItem

JMenuItem.AccessibleJMenuItem

Inner classes inherited from class com.sun.java.swing.AbstractButton

AbstractButton.AccessibleAbstractButton, AbstractButton.ButtonChangeListener

Inner classes inherited from class com.sun.java.swing.JComponent

JComponent.AccessibleJComponent

Fields inherited from class com.sun.java.swing.AbstractButton

actionListener, BORDER_PAINTED_CHANGED_PROPERTY, changeEvent, changeListener, DISABLED_ICON_CHANGED_PROPERTY, DISABLED_SELECTED_ICON_CHANGED_PROPERTY, FOCUS_PAINTED_CHANGED_PROPERTY, HORIZONTAL_ALIGNMENT_CHANGED_PROPERTY, HORIZONTAL_TEXT_POSITION_CHANGED_PROPERTY, ICON_CHANGED_PROPERTY, itemListener, MARGIN_CHANGED_PROPERTY, MNEMONIC_CHANGED_PROPERTY, MODEL_CHANGED_PROPERTY, model, PRESSED_ICON_CHANGED_PROPERTY, ROLLOVER_ENABLED_CHANGED_PROPERTY, ROLLOVER_ICON_CHANGED_PROPERTY, ROLLOVER_SELECTED_ICON_CHANGED_PROPERTY, SELECTED_ICON_CHANGED_PROPERTY, TEXT_CHANGED_PROPERTY, VERTICAL_ALIGNMENT_CHANGED_PROPERTY, VERTICAL_TEXT_POSITION_CHANGED_PROPERTY

Fields inherited from class com.sun.java.swing.JComponent

accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Constructor Summary

JCheckBoxMenuItem()
Creates an initially unselected checkboxMenuItem with no set text or icon.

JCheckBoxMenuItem(Icon icon)
Creates an initially unselected checkboxMenuItem with an icon.

JCheckBoxMenuItem(java.lang.String text)
Creates an initially unselected checkboxMenuItem with text.

JCheckBoxMenuItem(java.lang.String text, Icon icon)
Creates an initially unselected checkboxMenuItem with the specified text and icon.

JCheckBoxMenuItem(java.lang.String text, boolean b)
Creates a checkboxMenuItem with the specified text and selection state.

JCheckBoxMenuItem(java.lang.String text, Icon icon, boolean b)
Creates a checkboxMenuItem with the specified text, icon, and selection state.

Method Summary

AccessibleContext	getAccessibleContext() Get the AccessibleContext associated with this JComponent
java.lang.Object[]	getSelectedObjects() Returns an array (length 1) containing the checkbox menu item label or null if the checkbox is not selected.
boolean	getState() Returns the selected-state of the item.
java.lang.String	getUIClassID() Returns the name of the L&F class that renders this component.
void	init(java.lang.String text, Icon icon)
void	requestFocus()
void	setState(boolean b) Sets the selected-state of the item.
void	setUI(com.sun.java.swing.plaf.CheckBoxMenuItemUI ui) Sets L&F object that renders this component.
void	updateUI() Notification from the UIFactory that the L&F has changed.

Methods inherited from class com.sun.java.swing.JMenuItem

getAccelerator, getAccessibleContext, getComponent, getSubElements, getUIClassID, init, isArmed, menuSelectionChanged, processKeyEvent, processMouseEvent, setAccelerator, setArmed, setEnabled, setUI, updateUI

Methods inherited from class com.sun.java.swing.AbstractButton

addActionListener, addChangeListener, addItemListener, checkHorizontalKey, checkVerticalKey, createActionListener, createChangeListener, createItemListener, doClick, doClick, fireActionPerformed, fireItemStateChanged, fireStateChanged, getActionCommand, getDisabledIcon, getDisabledSelectedIcon, getHorizontalAlignment, getHorizontalTextPosition, getIcon, getLabel, getMargin, getMnemonic, getModel, getPressedIcon, getRolloverIcon, getRolloverSelectedIcon, getSelectedIcon, getSelectedObjects, getText, getUI, getVerticalAlignment, getVerticalTextPosition, init, isBorderPainted, isFocusPainted, isRolloverEnabled, isSelected, paintBorder, removeActionListener, removeChangeListener, removeItemListener, setActionCommand, setBorderPainted, setDisabledIcon, setDisabledSelectedIcon, setEnabled, setFocusPainted, setHorizontalAlignment, setHorizontalTextPosition, setIcon, setLabel, setMargin, setMnemonic, setMnemonic, setModel, setPressedIcon, setRolloverEnabled, setRolloverIcon, setRolloverSelectedIcon, setSelected, setSelectedIcon, setText, setUI, setVerticalAlignment, setVerticalTextPosition, updateUI

Methods inherited from class com.sun.java.swing.JComponent

addAncestorListener, addNotify, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getAccessibleContext, getActionForKeyStroke, getAlignmentX, getAlignmentY, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getGraphics, getHeight, getInsets, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getUIClassID, getVisibleRect, getWidth, getX, getY, grabFocus, hasFocus, isDoubleBuffered, isFocusCycleRoot, isFocusTraversable, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, paint, processComponentKeyEvent, processFocusEvent, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setAlignmentX, setAlignmentY, setAutoscrolls, setBorder, setBounds, setDebugGraphicsOptions, setDoubleBuffered, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setUI, setVisible, unregisterKeyboardAction, update, updateUI

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addNotify, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponentAt, getComponentAt, getComponent, getComponentCount, getComponents, getInsets, getLayout, getMaximumSize, getMinimumSize, getPreferredSize, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paintComponents, paint, paramString, preferredSize, printComponents, print, processContainerEvent, processEvent, removeAll, remove, remove, removeContainerListener, removeNotify, setLayout, update, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, deliverEvent, disable, disableEvents, dispatchEvent, doLayout, enable, enable, enableEvents, enableInputMethods, firePropertyChange, getAlignmentX, getAlignmentY, getBackground, getBounds, getBounds, getColorModel, getComponentAt, getComponentAt, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getGraphics, getHeight, getInputContext, getInputMethodRequests, getLocale, getLocation, getLocation, getLocationOnScreen, getMaximumSize, getMinimumSize, getName, getParent, getPeer, getPreferredSize, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, invalidate, isDisplayable, isDoubleBuffered, isEnabled, isFocusTraversable, isLightweight, isOpaque, isShowing, isValid, isVisible, keyDown, keyUp, layout, list, list, list, list, list, locate, location, lostFocus, minimumSize, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, paint, paramString, postEvent, preferredSize, prepareImage, prepareImage, printAll, print, processComponentEvent, processEvent, processFocusEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, remove, removeComponentListener, removeFocusListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFont, setForeground, setLocale, setLocation, setLocation, setName, setSize, setSize, setVisible, show, show, size, toString, transferFocus, update, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notifyAll, notify, toString, wait, wait, wait

Constructor Detail

JCheckBoxMenuItem

public JCheckBoxMenuItem()

Creates an initially unselected checkboxMenuItem with no set text or icon.

JCheckBoxMenuItem

public JCheckBoxMenuItem(Icon icon)

Creates an initially unselected checkboxMenuItem with an icon.

Parameters:

icon - the icon of the CheckBoxMenuItem.

JCheckBoxMenuItem

public JCheckBoxMenuItem(java.lang.String text)

Creates an initially unselected checkboxMenuItem with text.

Parameters:

text - the text of the CheckBoxMenuItem

JCheckBoxMenuItem

public JCheckBoxMenuItem(java.lang.String text,
                         Icon icon)

Creates an initially unselected checkboxMenuItem with the specified text and icon.

Parameters:

text - the text of the CheckBoxMenuItem

icon - the icon of the CheckBoxMenuItem

JCheckBoxMenuItem

public JCheckBoxMenuItem(java.lang.String text,
                         boolean b)

Creates a checkboxMenuItem with the specified text and selection state.

Parameters:

text - the text of the CheckBoxMenuItem.

b - the selected state of the checkboxmenuitem

JCheckBoxMenuItem

public JCheckBoxMenuItem(java.lang.String text,
                         Icon icon,
                         boolean b)

Creates a checkboxMenuItem with the specified text, icon, and selection state.

Parameters:

text - the text of the CheckBoxMenuItem

icon - the icon of the CheckBoxMenuItem

b - the selected state of the checkboxmenuitem

Method Detail

init

protected void init(java.lang.String text,
                    Icon icon)

Overrides:

init in class JMenuItem

setUI

public void setUI(com.sun.java.swing.plaf.CheckBoxMenuItemUI ui)

Sets L&F object that renders this component.

Parameters:

ui - the new L&F object CheckBoxMenuItemUI

See Also:

getUI

updateUI

public void updateUI()

Notification from the UIFactory that the L&F has changed.

Overrides:

updateUI in class JMenuItem

See Also:

updateUI

getUIClassID

public java.lang.String getUIClassID()

Returns the name of the L&F class that renders this component.

Returns:

"CheckBoxMenuItemUI"

Overrides:

getUIClassID in class JMenuItem

See Also:

getUIClassID, getUI

getState

public boolean getState()

Returns the selected-state of the item. This method exists for AWT compatibility only. New code should use isSelected() instead.

Returns:

true if the item is selected

setState

public void setState(boolean b)

Sets the selected-state of the item. This method exists for AWT compatibility only. New code should use setSelected() instead.

Parameters:

b - a boolean value indicating the item's selected-state, where true=selected

getSelectedObjects

public java.lang.Object[] getSelectedObjects()

Returns an array (length 1) containing the checkbox menu item label or null if the checkbox is not selected.

Returns:

an array containing 1 Object -- the text of the menu item -- if the item is selected, otherwise null

Overrides:

getSelectedObjects in class AbstractButton

requestFocus

public void requestFocus()

Overrides:

requestFocus in class JComponent

getAccessibleContext

public AccessibleContext getAccessibleContext()

Get the AccessibleContext associated with this JComponent

Specified by:

getAccessibleContext in interface Accessible

Returns:

the AccessibleContext of this JComponent

Overrides:

getAccessibleContext in class JMenuItem